home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 010a / org133.zip / ORG.DOC < prev    next >
Text File  |  1991-03-06  |  46KB  |  1,133 lines
  1.  
  2.  
  3.           Documentation for ORG V1.33         Copyright 1990, M.H. Greve
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.                         ORG - Hard Disk Organizer Utility
  25.  
  26.                                 Copyright (1990)
  27.                              M.H. Greve + D. Rifkind
  28.                                All Rights Reserved
  29.  
  30.  
  31.  
  32.                         Distributed by:
  33.  
  34.                                Greve Computer Systems
  35.                                Aubrigstrasse 23
  36.                                CH 8804 AU
  37.                                Switzerland
  38.  
  39.  
  40.  
  41.  
  42.           Documentation for ORG V1.33         Copyright 1990, M.H. Greve
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.                                      TABLE OF CONTENTS
  51.  
  52.  
  53.        1. Introduction                                               1
  54.        2. Getting Started - Installation                             2
  55.        3. About ORG                                                  4
  56.        4. The configuration file                                     6
  57.        5. Command Line Switches                     11
  58.        6. Limitations and Restrictions                              13
  59.        7. Acknowledgment                        14
  60.  
  61.       Appendix A - Program Termination codes            15
  62.           Appendix B - Error Messages                               15
  63.       Appendix C - Bugs                        18
  64.       Registration Form                        19
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.                                        Page 1
  72.           
  73.           Documentation for ORG V1.33         Copyright 1990, M.H. Greve
  74.  
  75.  
  76.  
  77.  
  78.        1. INTRODUCTION
  79.        ---------------
  80.  
  81.       ORG is a Disk Organizer with a lot of features not found in
  82.       other similar programs. In addition to the traditional function
  83.       of un-fragmenting your disk, ORG will allow you to customize the
  84.           sequence in which files are placed on the disk, let you "lock"
  85.           (leave unchanged) any file or group of files, sort files in any
  86.           directory and delete temporary files on the fly, all in a single
  87.           pass.  Moreover, ORG does this as fast or faster than most
  88.           commercially available de-fragmentation software. As you will
  89.           discover when you use the program:
  90.  
  91.           "ORG is the only Disk Organizer that truly deserves the name!"
  92.  
  93.  
  94.  
  95.           User Supported Software:
  96.           ------------------------
  97.  
  98.           ORG is distributed as "Shareware" or "User Supported Software"
  99.           and is fully copyrighted.  You may have received a copy of ORG
  100.           free from a friend or a bulletin board or (for a nominal fee)
  101.           from a user's group or Shareware library.  However you received
  102.           ORG, you have a perfectly legal copy of the software.  You are
  103.           encouraged to make as many copies of the software and this
  104.           documentation as you like and distribute it to anyone you want,
  105.           as long as you do not charge a fee (other than to cover your own
  106.           distribution cost) and distribute only complete, unaltered copies
  107.           of the package, exactly as you received it.  If, after trying the
  108.           program for a few weeks, you find it useful and use it regularly,
  109.           you must register your copy by completing the form included at
  110.           the end of this documentation and sending it together with your
  111.           registration fee of US$25.00 to the address shown on the form.
  112.           Full 'C' source code is available for an additional US$20.- to
  113.           registered users.
  114.  
  115.           As a registered user you will receive a copy of the very latest
  116.           version of ORG and will be entitled to free support and will
  117.           receive upgrade notices and "bug fixes" as and when these become
  118.           available (for one full year from the date of purchase).
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.                                        Page 2
  127.           
  128.           Documentation for ORG V1.33         Copyright 1990, M.H. Greve
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.        2. GETTING STARTED & INSTALLATION
  137.        ---------------------------------
  138.  
  139.           This section provides step by step instructions for running ORG
  140.           on any drive of a standard IBM PS/2, IBM PC, XT, AT, or any 100%
  141.           compatible running under MSDOS 2.10, or higher.
  142.  
  143.           If you are eager to run ORG right away, you need only read this
  144.           chapter now and can revert to the other chapters for a detailed
  145.           description of the program's features and options later.
  146.  
  147.           Note that you should never attempt to run ORG under a multi-
  148.           tasking operating system or OS-shell such as OS/2, Windows,
  149.           DesqView or Software Carousel, nor activate any "pop-up" program
  150.           (eg. SideKick) while the program is running.
  151.  
  152.           1. Before you start, use the DOS DISKCOPY command to make a
  153.              duplicate of the distribution disk or, if you downloaded ORG
  154.              from a bulletin board, save the archive file onto two
  155.              diskettes and store one (the original) in a safe place.
  156.  
  157.           2. ORG does not require any special installation procedure. You
  158.              may run ORG from the backup floppy disk or from a subdirectory
  159.              on your hard disk.  If you wish to run the program from your
  160.              hard disk, copy the ORG.EXE program file to a subdirectory
  161.              which is included in your DOS PATH (see your DOS User's Guide)
  162.              and place the ORG.CFG file in the same directory or in the
  163.              root directory of the drive you wish to "de-frag".
  164.  
  165.           3. If you are running ORG for the first time, make sure you have
  166.              a current backup of the drive you wish to un-fragment. You may
  167.              also wish to remove any resident utilities such as disk-cache
  168.              programs in order to avoid any potential conflicts.
  169.  
  170.           4. Run the DOS CHKDSK program on the drive and correct any errors
  171.              reported by it before proceeding further. If there are lost
  172.              clusters or cross-linked files on the disk, ORG will detect
  173.              this and refuse to run.
  174.  
  175.           5. Make the drive and/or directory containing ORG.EXE the current
  176.              drive/directory. (Not necessary if ORG.CFG is in a directory
  177.              contained in your PATH).
  178.  
  179.  
  180.  
  181.                                        Page 3
  182.           
  183.           Documentation for ORG V1.33         Copyright 1990, M.H. Greve
  184.  
  185.  
  186.  
  187.  
  188.           6. Start ORG from the DOS prompt by typing:
  189.  
  190.                      ORG [d:]  <Enter>
  191.  
  192.           The parameter d: is any valid drive specifier known to your system
  193.           (except a RAM disk or Network drive). ORG assumes the current
  194.           default drive if you omit the drive specifier.
  195.  
  196.  
  197.           ORG will read the configuration file and the drive parameters of
  198.           the disk, analyze this data and then wait for you to press the
  199.           <Enter> key before proceeding to de-fragment the drive. If you did
  200.           not copy the configuration file, ORG will warn you of this and
  201.           will use its own internal default settings.  You may view these
  202.           defaults and the configuration settings by pressing the <F1> key.
  203.           If you decide you don't want to run ORG right now, press <Escape>,
  204.           and ORG will return you to the DOS environment.
  205.  
  206.           If you have used other de-fragmentation programs before, the
  207.           screen layout with the large symbolic map of your disk will look
  208.           familiar.  The available commands are shown in the highlighted
  209.           box on the right of the disk-map window.
  210.  
  211.           ORG can take anywhere from several seconds to several minutes to
  212.           de-fragment your disk.  Typically, it will take about 5 minutes
  213.           to de-fragment a 32MB partition with about 20MB of data.  You may
  214.           abort ORG at any time by simply pressing the <Escape> key.  The
  215.           integrity of your data is guaranteed if you exit in this manner.
  216.  
  217.           After optimization is completed, ORG will ask whether you wish to
  218.           re-boot the system.  Certain resident programs retain information
  219.           about the previous state of the disk.  Unless you are sure that
  220.           you have no such programs in your system, you should type "Y" to
  221.           allow ORG to initiate a system reset. (The re-boot query is not
  222.           displayed if you have used ORG on a removeable diskette).
  223.  
  224.           Laptop users:
  225.           -------------
  226.  
  227.           If you are running ORG on a laptop computer you may find the
  228.           display difficult to read.  This is because Laptops often emulate
  229.           color displays on the built in monochrome screen, making certain
  230.           colors hard to distinguish.  In such cases, re-start ORG using
  231.           the /L command line switch which forces ORG to use its monochrome
  232.           display settings irrespective of the type of video adaptor in-
  233.           stalled  (see chapter 6: Command Line Switches).
  234.  
  235.  
  236.                                        Page 4
  237.           
  238.           Documentation for ORG V1.33         Copyright 1990, M.H. Greve
  239.  
  240.  
  241.  
  242.  
  243.           NEVER re-boot or switch off the computer while ORG is running, as
  244.           this may cause loss of data. As a precaution, it is a good idea
  245.           to run ORG after you have made a backup of your hard disk,
  246.           particularly if you live in an area where power dips are common.
  247.  
  248.  
  249.  
  250.        3. ABOUT ORG
  251.        ------------
  252.  
  253.           You may run ORG on any valid drive in your system. This may be
  254.           a floppy, a hard disk, or a logical partition on your hard disk.
  255.           ORG cannot (and should not) run on virtual (RAM) drives or Network
  256.           drives and will issue a warning if you specify one accidentally.
  257.           If your computer is equipped with an EGA or VGA screen, ORG will
  258.           detect when the screen is set to 43/50 line and automatically use
  259.           the full screen display.  You may force ORG to display in either
  260.           25-line or 43/50-line mode by using the appropriate command line
  261.           switches (see Chapter 5).
  262.  
  263.  
  264.           How ORG works:
  265.           --------------
  266.  
  267.           After you start ORG, the program reads any command line options
  268.           and then searches for the configuration file ORG.CFG. ORG searches
  269.           for this file in the root directory of the target drive you
  270.           specified and then in the drive/directory from which ORG was
  271.           loaded.  This somewhat restrictive search ensures good control
  272.           over the configuration file used and prevents ORG from acciden-
  273.           tally loading an old version that may be "visible" in your DOS
  274.           PATH.  ORG.CFG contains a list of special commands that allow you
  275.           to control the way in which ORG organizes the files on your disk.
  276.           (Refer to chapter 4: The Configuration File).
  277.  
  278.           ORG reads and analyses the parameters, directory structure and
  279.           FAT (File Allocation Table) of the drive and processes the
  280.           "delete" and "sort" command functions in memory, WITHOUT writing
  281.           to your hard disk.  ORG pauses at this stage and waits for you to
  282.           press the <Enter> key before beginning to organize the files.  If
  283.           you abort the program by pressing the <Esc> key at this stage, no
  284.           data on the disk will have been modified.
  285.  
  286.           By pressing the <F1> key you can view the configuration settings
  287.           before proceeding, to assure yourself that ORG will perform the
  288.           desired functions.
  289.  
  290.  
  291.                                        Page 5
  292.           
  293.           Documentation for ORG V1.33         Copyright 1990, M.H. Greve
  294.  
  295.  
  296.  
  297.  
  298.           Once ORG has started organizing the drive, you can still safely
  299.           interrupt the process any time by pressing the <Esc> key. The
  300.           consistency and integrity of your files is guaranteed if you exit
  301.           ORG in this way, however ALL files which you flagged for deletion
  302.           will have been erased.
  303.  
  304.           WARNING: NEVER power off or re-boot your computer while ORG is
  305.                    running as this may cause loss of data integrity which
  306.                    can be very difficult to recover even with programs such
  307.                    as the Norton (TM) Utilites.
  308.  
  309.  
  310.           While ORG runs, it displays its progress on a disk-map in a window
  311.           of your screen.  In this map, each visible block corresponds to
  312.           one or more physical clusters on the drive.  The blocks that have
  313.           already been processed are highlighted.  Special symbols are used
  314.           to indicate locked or bad clusters.  The blocks being moved are
  315.           highlighted with an 'r' (read) or 'W' (write).  Note that ORG will
  316.           always move the largest possible contiguous block of clusters.  If
  317.           it can, it will move them to the final destination immediately. If
  318.           not, it will write them to the end of the disk temporarily.  This
  319.           process is very efficient since it ensures that each cluster on
  320.           the disk is never moved more than twice in a session.
  321.  
  322.           Frequently, ORG will detect that it already has the clusters it
  323.           needs in memory and will not re-read them.  This feature not only
  324.           saves time, but also prevents a lot of unnecessary "head-
  325.           thrashing" action.
  326.  
  327.           ORG updates the FAT and directory areas after writing each group
  328.           of blocks, ensuring disk integrity as far as technically possible.
  329.           In fact, loss of data is only possible during the relatively
  330.           short time when the directories and FAT are "out of synch".  This
  331.           is important because ORG will retain data integrity at all other
  332.           times, even if a power dip were to occur during a "write" to the
  333.           data area.
  334.  
  335.           You will notice that ORG often appears to read or write to a
  336.           protected area or an area that has already been processed. This
  337.           is normal and is because each block usually represents several
  338.           clusters.
  339.  
  340.           The highlighted box to the right of the disk-map displays the
  341.           currently available command(s).  A "percent completed" counter
  342.           above this box keeps track of ORG's progress.
  343.  
  344.  
  345.  
  346.                                        Page 6
  347.           
  348.           Documentation for ORG V1.33         Copyright 1990, M.H. Greve
  349.  
  350.  
  351.  
  352.  
  353.           File order and sequence:
  354.           ------------------------
  355.  
  356.           By default, ORG skips all system files and places all directories
  357.           first on the disk.  The sequence in which ORG places remaining
  358.           files on the disk is determined by the sequence in which it
  359.           encounters the file name entries in the (sub)directories.  You
  360.           may override or modify these default settings by using the "sort"
  361.           and "order" commands in the configuration file, ORG.CFG (see
  362.           Chapter 4: The Configuration File).
  363.  
  364.           If you were to compare the result of organizing a disk under ORG
  365.           with that of other similar programs, you might find that some
  366.           programs will start organizing the disk over again.  This does not
  367.           mean that ORG failed to optimize your disk, it merely indicates
  368.           that there is more than one valid way (and no right way) to
  369.           organize directories and files on the disk.
  370.  
  371.  
  372.  
  373.        4. THE CONFIGURATION FILE
  374.        -------------------------
  375.  
  376.           The features available to you through use of the configuration
  377.           file make ORG the most powerful and versatile Disk Organizer
  378.           available today.
  379.  
  380.           The configuration file is an ASCII text file containing special
  381.           ORG commands, similar to a DOS batch file. When you run ORG
  382.           without specifying a configuration file name, it searches for
  383.           the ORG.CFG file in the root directory of the target drive you
  384.           selected when you started the program and then in the drive/path
  385.           where the ORG.EXE program resides.  This restrictive search
  386.           lets you keep a customized configuration file for each drive in
  387.           the root directory of your hard disk.
  388.  
  389.           NOTE:
  390.           Under DOS versions earlier than 3.0, ORG will search for the
  391.           configuration file in the current default directory (CWD) instead
  392.           of in the directory from which ORG.EXE was loaded.
  393.  
  394.           ORG allows you to override the default name of the configuration
  395.           file (ORG.CFG), by simply specifying a file name of the form
  396.           "/@[d:][\pathspec\]filename" on the ORG command line. If you only
  397.           specify a filename, ORG will search the root directory of the
  398.           target drive and directory where the ORG.EXE program resides.
  399.  
  400.  
  401.                                        Page 7
  402.           
  403.           Documentation for ORG V1.33         Copyright 1990, M.H. Greve
  404.  
  405.  
  406.  
  407.  
  408.           The configuration filespec must be immediately preceded by the
  409.           "@" sign.
  410.  
  411.           ORG.CFG uses a simple command structure similar to that used in
  412.           compiler MAKE files.  A sample configuration file (ORG.CFG) is
  413.           included in the ORG package. Each line in the configuration file
  414.           represents a command for ORG.  The command syntax is:
  415.  
  416.           <function> [\path\][filename]  [qualifier]  [#<comment>]
  417.  
  418.           The first element on each line is the function to be performed.
  419.           This is followed by a file specifier in the form "path\filename".
  420.           Each command can take a qualifier that tells ORG which file
  421.           attributes are to be used to further specify the file(s). If you
  422.           specified the "sort" command (see below), the qualifier has a
  423.           different meaning: it indicates the type and sequence of the sort
  424.           keys.
  425.  
  426.  
  427.           Here are a few examples of valid commands:
  428.  
  429.           lock     *.* +s           # lock all system files
  430.           delete   \TEMP\*.back     # delete all .BACK files
  431.           sort     +n-t             # sort by filename, newest files first
  432.           order    *.EXE            # place all .EXE files first
  433.  
  434.  
  435.           In the following you will find a detailed description of each
  436.           element of the configuration command:
  437.  
  438.  
  439.           Commands:
  440.           ---------
  441.  
  442.           lock -   prevents ORG from moving a specified file or group of
  443.                    files on the drive. This is essential to avoid moving
  444.                    files such as your DOS system files on the bootable
  445.                    partition of your disk.  It may also be necessary to
  446.                    lock the identification files used by certain copy-
  447.                    protected software. The "lock" function takes an optional
  448.                    attribute parameter.  ORG's default setting locks all
  449.                    "system" files.  You may disable this default setting
  450.                    using the /nod command line option.
  451.  
  452.           sort -   allows you to sort the contents of the directory in
  453.                    ascending or descending order by filename, extension,
  454.                    date & time, or size. A sort is always performed on an
  455.  
  456.                                        Page 8
  457.           
  458.           Documentation for ORG V1.33         Copyright 1990, M.H. Greve
  459.  
  460.  
  461.  
  462.  
  463.                    entire directory; if a filename is given, it is ignored
  464.                    by ORG for the sort operation. The qualifier determines
  465.                    the type and sequence of the sort operation.
  466.  
  467.                    The command always places subdirectories first and then
  468.                    sorts directory names and filenames in two consecutive
  469.                    passes.
  470.  
  471.                    Note:  ORG processes directories and files in the order
  472.                    in which they are encountered.  Using the "sort" command
  473.                    thus affects the sequence in which ORG will place the
  474.                    files on the drive.  The "order" command described below
  475.                    allows you to override this sequence by specifying that
  476.                    certain files (or groups of files) be processed first.
  477.  
  478.  
  479.       order -  allows you to force certain files, or groups of files
  480.                    (specified using DOS style wild selections) to be placed
  481.                    first on the disk.  If you use several "order" commands,
  482.                    they are processed in the sequence in which they appear
  483.                    in the configuration file.  If a group of files is
  484.                    specified, they are processed in sequence, by directory
  485.                    and in the sequence in which they appear in the directory
  486.                    structure.
  487.  
  488.                    Do not confuse this command with the "sort" command
  489.            described above, which sorts directory and file names
  490.            and thus implicitly determines the sequence of files.
  491.  
  492.            As with the lock and delete options, you may specify one
  493.            or more file attributes as qualifiers for the path\
  494.            filename spec.  Note that ORG's default settings will
  495.            place all directories first on the disk (behind the
  496.            system files and/or the Volume identifier).    You may
  497.            disable this default setting using the /nod command line
  498.                    option.
  499.  
  500.  
  501.           delete - allows you to specify a file or group of files that you
  502.                    wish to delete from the drive.  For example, you might
  503.                    want to delete .BAK or .TMP files on your drive prior to
  504.                    de-fragmenting. The default setting only allows ORG to
  505.                    delete normal files that is, files that have either no
  506.                    attributes or only the "archive" attribute set.  You may
  507.                    override this default by explicitly specifying one or
  508.                    more file attributes.
  509.  
  510.  
  511.                                        Page 9
  512.           
  513.           Documentation for ORG V1.33         Copyright 1990, M.H. Greve
  514.  
  515.  
  516.  
  517.  
  518.                    NOTE: Use this command with care, because if you
  519.                    accidentally delete a file with ORG, you will NOT be able
  520.                    to "un-erase" it any more later! For this reason, ORG
  521.                    will ignore a command to delete all files on the disk.
  522.                    ORG will also ignore requests to delete directories.
  523.  
  524.           The order in which commands are executed by ORG is fixed in the
  525.           program. Irrespective of where they appear in the configuration
  526.           file, commands are processed in the following sequence:
  527.  
  528.                    1.  lock
  529.                    2.  delete
  530.                    3.  sort
  531.                    4.  order
  532.  
  533.           Because any "lock" commands are processed first, they will take
  534.           precedence over "delete" commands that occur later, ie. ORG will
  535.           NOT delete files that have been "frozen" by a previous lock
  536.           command.
  537.  
  538.       If several similar commands occur, they are processed in the order
  539.           in which they appear in the configuration file, eg:
  540.  
  541.                    order  \command.com
  542.                    order  *.COM
  543.                    order  *.EXE
  544.  
  545.  
  546.  
  547.           The Path/Filename Specifier:
  548.           ----------------------------
  549.  
  550.           The second element in a command is the filename specifier. This
  551.           element follows MS-DOS conventions for directory and filenames.
  552.           You may specify any valid path (commands with invalid paths are
  553.           ignored; no error message is generated).
  554.  
  555.       The filename may contain the "wild-card" symbols '*' and '?'. The
  556.           filename may be omitted entirely if the pathname is terminated
  557.           by a backslash (\). ORG will then assume you specified all files
  558.           in this directory.  The following are some examples of valid
  559.           filename specifiers:
  560.  
  561.           delete   \brief\backup\   # delete all files in \BRIEF\BACKUP
  562.           order    \*.WK1           # place all Lotus 2.xx files first
  563.           delete   *.tmp  +r        # delete .TMP files, including read-only
  564.  
  565.  
  566.                                        Page 10
  567.  
  568.        Documentation for ORG V1.33            Copyright 1990, M.H. Greve
  569.  
  570.  
  571.  
  572.  
  573.           Note that the path\filename specifier is optional, however it may
  574.           only be omitted if you provide a qualifier on the line. This means
  575.           you must EITHER include a filename OR a qualifier (see below) and
  576.           may not omit both; a command containing a function only is
  577.           flagged as an error.
  578.  
  579.  
  580.  
  581.           The Command Qualifier:
  582.           ----------------------
  583.  
  584.           The qualifier has two functions.  For the "lock", "delete" and
  585.           "order" options it specifies the desired file attributes. For the
  586.           "sort" option, it defines the type, sequence and order (ascending
  587.           or descending) of sorting.  The qualifier is always optional.
  588.           Valid file attribute qualifiers are:
  589.  
  590.               +r        # Read-only files
  591.               +h        # Hidden files
  592.               +s        # System files
  593.               +d        # subdirectories
  594.               +a        # archive files
  595.  
  596.           A '+' (plus) or '-' (minus) sign must precede the attribute.  The
  597.           sign is used solely as a separator between consecutive attributes
  598.           and has no other meaning: it does NOT qualify the attribute. Both
  599.           signs are allowed for consistency with the sort qualifiers
  600.           described below and for possible future enhancement.  Attributes
  601.           may be combined on a command line. Some attributes are invalid
  602.           for certain commands and are ignored.  For example, the command
  603.           "delete *.* +d" will NOT cause subdirectories to be deleted.
  604.  
  605.           File attributes are of little or no significance in file sorting
  606.           operations.  The meaning of the qualifier is therefore quite
  607.           different for the "sort" option.  The four sort qualifiers
  608.           determine the type and order of the sort.  The following are valid
  609.           "sort" qualifiers:
  610.  
  611.               +n | -n   # sort by name
  612.               +e | -e   # sort by extension
  613.               +t | -t   # sort by date/time field
  614.               +s | -s   # sort by file size
  615.  
  616.           The sign preceding the qualifier acquires meaning in that it now
  617.           determines the direction of the sort, viz. ascending (+) or
  618.           descending (-) order.  You may specify multiple sort options; the
  619.           sequence of qualifiers determines the sort order.  Sorts are
  620.  
  621.                                        Page 11
  622.           
  623.        Documentation for ORG V1.33            Copyright 1990, M.H. Greve
  624.  
  625.  
  626.  
  627.  
  628.           performed on the entire directory, ie. any filenames you specify
  629.           are ignored. The following sort commands are identical:
  630.  
  631.               sort  \DOCS\*.DOC  +e-s
  632.               sort  \DOCS\*.*    +e-s
  633.               sort  \DOCS\       +e-s
  634.  
  635.           They each cause all files in the \DOCS subdirectory to be sorted
  636.           in ascending order by extension, placing the largest files first.
  637.  
  638.           Note that some combinations of sort qualifiers are mutually
  639.           exclusive: a sort by name, extension AND size is meaningless
  640.           because all files are uniquely defined by 'filename.ext'.
  641.           Similarly, subdirectories cannot be sorted by size.
  642.  
  643.  
  644.           Commenting the configuration file:
  645.           ---------------------------------
  646.  
  647.           You may include comments in the configuration file to help you
  648.           document your commands.  Comments must be preceded by a '#' sign.
  649.           They may be placed after a command or on a separate line in the
  650.           configuration file.  If comments are placed after a command, you
  651.           must leave at least one blank space (or TAB) behind the command.
  652.  
  653.             order *.COM           # This is a comment following a command.
  654.             # Comments are also allowed on empty lines.
  655.  
  656.  
  657.  
  658.        5. COMMAND LINE SWITCHES
  659.        ------------------------
  660.  
  661.           ORG supports a small set of command line switches that control
  662.           ORG's global settings.  The complete command line is shown here:
  663.  
  664.        ORG [d:] [/a] [/e] [/q] [/d] [/25|/50] [/l] [/h] [/nod] [/@configfile]
  665.  
  666.           where:
  667.  
  668.           d:      is any valid drive specifier (A: - Z:).
  669.  
  670.           /a      Automatic mode: ORG runs without pausing for confirmation
  671.                   and exits to DOS without pausing at the end of the run.
  672.                   This option will also suppress the re-boot query message
  673.                   normally displayed by ORG at the end of each run.
  674.  
  675.  
  676.                                        Page 12
  677.           
  678.        Documentation for ORG V1.33            Copyright 1990, M.H. Greve
  679.  
  680.  
  681.  
  682.  
  683.           /e      Exit to DOS: At the end of each run, ORG will normally
  684.                   display a query message, asking if you wish to re-boot
  685.                   your system to reset any programs which may have retained
  686.                   information about the drive's previous state.  The /e
  687.                   option suppresses this message and causes ORG to exit to
  688.                   DOS immediately.  (The re-boot query is not displayed if
  689.                   you have used ORG on a removeable diskette).
  690.  
  691.           /q      Quiet mode: disables sound.
  692.  
  693.           /d      Directories only: quick ORGanization of directories only.
  694.  
  695.           /l      Laptop mode: forces a monochrome display on laptops that
  696.                   emulate color video adaptors.
  697.  
  698.           /25     Forces ORG to use a 25 line (text) display, irrespective
  699.                   of the initial display mode.
  700.  
  701.           /50     Forces ORG to use the 43-line (EGA) or 50-line (VGA)
  702.                   display, irrespective of the initial display mode.
  703.  
  704.           /h      Help: This switch overrides all others and simply causes
  705.                   a list of all available options to be displayed.
  706.  
  707.           /nod    No defaults: turns off all default configuration options.
  708.                   ORG's default configuration locks system files and places
  709.                   directories first on the drive.  Disabling these defaults
  710.                   may cause certain otherwise unmovable system files to be
  711.                   moved and should only be used by experienced users. You
  712.                   will have to enter every option explicitly.
  713.                   The /nod option may be used to make room for, or replace
  714.                   the system files on the bootable drive without recourse
  715.                   to the DOS SYS command.
  716.  
  717.                   WARNING:  Use the "/nod" switch with great care,
  718.                   particularly on your bootable drive (C:).
  719.  
  720.           /@fname Used to specify an alternate path\filename to override
  721.                   the default configuration file name (ORG.CFG).
  722.                   Example: "ORG /@MYCONFIG.CFG"
  723.  
  724.           Switches may be used alone or together (except /h) and may be
  725.           placed in any order on the command line.  Blank separators are
  726.           optional except before the drive specifier.  You may use a UNIX
  727.           style dash '-' as a delimiter if you prefer. Thus any of the
  728.           following commands are valid:
  729.  
  730.  
  731.                                        Page 13
  732.           
  733.        Documentation for ORG V1.33            Copyright 1990, M.H. Greve
  734.  
  735.  
  736.  
  737.  
  738.                 ORG /q/a A:
  739.                 ORG C: -nod -l
  740.                 ORG /a/l A:-nod -@D:\MYDIR\MYCONFIG.CFG
  741.  
  742.  
  743.  
  744.        6. LIMITATIONS AND RESTRICTIONS
  745.        -------------------------------
  746.  
  747.           Operating System:
  748.           -----------------
  749.  
  750.           ORG requires MS-DOS 2.1 or higher to run. It must NOT be run under
  751.           a multitasking Environment such as OS/2, Windows, DesqView or
  752.           Sorware Carousel.  Popular memory management enhancers for 386
  753.           processors such as 386MAX (TM) and QEMM are however compatible
  754.           with ORG.
  755.  
  756.  
  757.           RAM- and Network drives:
  758.           ------------------------
  759.  
  760.           ORG will not run with RAM drives or Network drives.  If the
  761.           program detects either of these two devices, it will abort with
  762.           an appropriate error message.
  763.  
  764.  
  765.           Large partition support:
  766.           ------------------------
  767.  
  768.           ORG places no restrictions on the size of the drive and will
  769.           handle volumes greater than 32MB if you are using MS-DOS 4 or
  770.           higher or Compaq DOS 3.31.  The only limit is the amount of free
  771.           memory in your system: there must be enough room for ORG to keep
  772.           a complete copy of the directory structure resident in memory.
  773.  
  774.  
  775.           Compatibility:
  776.           --------------
  777.  
  778.           Certain of ORG's options may change the order of files on your
  779.           disk and/or delete files without using DOS functions. Certain
  780.           disk utilities such as QDOS or the PC-TOOLS UNERASE or DOS's
  781.           FASTOPEN may retain information about the drive's previous state.
  782.           As a result, these programs may fail to operate correctly after
  783.           ORG has been run.  At the end of each run, ORG will query if you
  784.           want to re-boot the system in order to reset these programs'
  785.  
  786.                                        Page 14
  787.           
  788.        Documentation for ORG V1.33            Copyright 1990, M.H. Greve
  789.  
  790.  
  791.  
  792.  
  793.           buffers.  Unless you are quite sure that you are not using any
  794.           programs of this type, you should always allow ORG to re-boot the
  795.           computer.  Use the /e command line option to suppress ORG's
  796.           re-boot query message.  A System Reset is normally required only
  797.           for hard disks.  Thus, if you have used ORG on a removeable
  798.           diskette, the query message is not displayed.
  799.  
  800.           If you are using utilities which maintain a reference file with
  801.           disk status information, you may have to re-run these programs to
  802.           force them to rebuild the database.
  803.  
  804.           There are no other known incompatibilities with ORG.  Many
  805.           resident programs such as popular disk cache programs will not
  806.           interfere with ORG's operation, however you should avoid running
  807.           ORG in the presence of such resident utilites unless you
  808.           understand their function well and test them carefully first!
  809.  
  810.  
  811.  
  812.        7. ACKNOWLEDGMENT
  813.        -----------------
  814.  
  815.           The original idea for ORG is by David Rifkind, Newbury Park, CA.
  816.           Dave's "cluster-mover" concept is largely responsible for the
  817.           awesome speed with which ORG de-fragments your hard disk! I am
  818.           very grateful to Dave for having donated me his code, without
  819.           which I doubt I would have been able to complete ORG.
  820.  
  821.                        Page 15
  822.           
  823.        Documentation for ORG V1.33            Copyright 1990, M.H. Greve
  824.  
  825.  
  826.  
  827.  
  828.        APPENDIX A - PROGRAM TERMINATION CODES
  829.        --------------------------------------
  830.  
  831.           When ORG finishes a run, it sets the system ERRORLEVEL code
  832.           before exiting to DOS.  You may use these codes to determine
  833.           whether or not ORG completed the pass successfully and glean
  834.           some information about the cause of an abnormal termination,
  835.           for example if you are running ORG from a batch file.
  836.  
  837.           ORG generates the following ERRORLEVEL codes:
  838.  
  839.           ERRORLEVEL
  840.  
  841.               0  -  Normal program termination.
  842.  
  843.               1  -  Program aborted by user. Issued when you interrupt
  844.                     execution with the <ESC> key or exit in response to
  845.                     a warning error message.
  846.  
  847.               2  -  Bad option on ORG command line
  848.  
  849.              -1  -  All other errors and abnormal end conditions.
  850.  
  851.  
  852.  
  853.  
  854.        APPENDIX B - ERROR MESSAGES
  855.        ---------------------------
  856.  
  857.           If an error occurs, ORG will generate one of three types of error
  858.           messages.
  859.  
  860.           User Errors:
  861.           ------------
  862.  
  863.           These will warn you of operating problems that are usually fairly
  864.           easy to correct, such as the use of an invalid drive letter or
  865.           that there is not enough memory for ORG to run. The following is
  866.           a list of "User Errors". Most messages are self-explanatory.
  867.  
  868.            1. "Not enough memory available for ORG to run. Remove
  869.                resident programs to increase available memory."
  870.  
  871.            2. "There are too many options in the configuration file.
  872.                ORG is limited to 50 configuration options."
  873.  
  874.  
  875.  
  876.                        Page 16
  877.           
  878.        Documentation for ORG V1.33            Copyright 1990, M.H. Greve
  879.  
  880.  
  881.  
  882.  
  883.            3. "The sector size of this disk is not 512 bytes.
  884.                ORG works only on disks with 512-byte sectors."
  885.  
  886.            4. "The boot record of this disk does not contain an
  887.                MS-DOS signature. This may not be a DOS disk.
  888.                       Continue anyway ? [Y/N]
  889.  
  890.            5. "The specified drive identifier is not known to your
  891.                system.  Re-try with a valid drive identifier."
  892.  
  893.            6. "The specified drive is probably RAM-drive or Network
  894.                drive.  ORG should only be used on local disks!
  895.                       Continue anyway ? [Y/N]
  896.  
  897.            7. "The boot record of this disk shows an invalid number
  898.                of sectors."
  899.  
  900.            8. "The media descriptor in this disk's file allocation
  901.                table does not match the one in the boot record."
  902.  
  903.            9. "The file allocation table has a bad link entry."
  904.  
  905.  
  906.           10. "There are cross-linked clusters on this disk."
  907.  
  908.  
  909.           11. "There is not enough free space on this disk for
  910.                ORG to work. You may need to delete some files."
  911.  
  912.  
  913.           12. "A cluster being used by a file is marked as available
  914.                in the file allocation table."
  915.  
  916.  
  917.           13. "A cluster being used by a file is marked as bad
  918.                in the file allocation table."
  919.  
  920.  
  921.           14. "There are lost clusters on this disk.
  922.  
  923.               Note: Use DOS's CHKDSK program to correct this problem.
  924.  
  925.  
  926.           15. "A subdirectory contains a bad entry."
  927.  
  928.  
  929.  
  930.  
  931.                        Page 17
  932.           
  933.        Documentation for ORG V1.33            Copyright 1990, M.H. Greve
  934.  
  935.  
  936.  
  937.  
  938.           Notes:
  939.           (i)    Error 4 frequently occurs when you attempt to ORGanize a
  940.                  RAM drive.
  941.  
  942.           (ii)   Errors 9, 10, 12, 13, 14 and 15 can usually be corrected
  943.                  with DOS's CHKDSK program (see your MS-DOS User's Guide
  944.                  for a detailed description of the CHKDSK command).
  945.  
  946.           (iii)  Error 8 may indicate a serious problem with the drive.
  947.                  Normally the problem can be fixed with a disk utility
  948.                  such as the "Norton Disk Doctor" (TM).
  949.  
  950.           (iv)   Errors 4 and 6 are warning errors only. You may force
  951.                  ORG to continue by answering "Y" at the prompt.
  952.  
  953.  
  954.           Disk Errors:
  955.           ------------
  956.  
  957.           All Disk Errors reported by ORG are serious errors that may
  958.           indicate a deterioration of your hard disk.  They are always
  959.           caused by a failure to read or write to a given sector on the
  960.           disk. Depending on where and when they occurred, these errors may
  961.           be recoverable.  If the bad sector is in the FAT (File Allocation
  962.           Table) area of your disk, you risk losing data.
  963.  
  964.           If ORG reports a DISK ERROR, exit and run DOS's CHKDSK program to
  965.           verify the error and then run a disk diagnostics/repair program
  966.           to recover as much data as possible and try to restore the files
  967.           from your backup.
  968.  
  969.           If ORG reports a "FATAL" error, it has failed during an attempt
  970.           to update the FAT or root directory areas.  In this case, there
  971.           is a serious risk of losing a significant amount of data.
  972.  
  973.           All disk errors return the DOS internal number of the error (xxxx)
  974.           and the number (nnnn) of the sector that caused the problem.  If
  975.           a FAT write error occurred in FAT #2, it is very likely you will
  976.           able to recover all your data.  The following messages may be
  977.           reported by ORG in the event of a disk access error:
  978.  
  979.  
  980.            1. "Recoverable error #xxxx,
  981.                reading sector #nnnn in the data area."
  982.  
  983.            2. "Recoverable error #xxxx,
  984.                writing sector #nnnn in the data area"
  985.  
  986.                        Page 18
  987.           
  988.        Documentation for ORG V1.33            Copyright 1990, M.H. Greve
  989.  
  990.  
  991.  
  992.  
  993.            3. "CRITICAL error #xxxx, reading sector #nnnn in FAT #m.
  994.                The Disk may be unusable."
  995.  
  996.            4. "FATAL error #xxxx, writing sector #nnnn in FAT #m.
  997.                Data may be destroyed!"
  998.  
  999.            5. "CRITICAL error #xxxx, reading sector #nnnn in the ROOT area.
  1000.                The Disk may be unusable."
  1001.  
  1002.  
  1003.            6. "FATAL error #xxxx, writing sector #nnnn in the Root area.
  1004.                Data may be destroyed!"
  1005.  
  1006.  
  1007.            Internal Errors:
  1008.            ----------------
  1009.  
  1010.            This last category of errors should NEVER occur. They are always
  1011.            associated with programming bugs and have been included solely
  1012.            to help with debugging. If you ever get an "Internal Error",
  1013.            please report it immediately and I will try and find the cause
  1014.            of the problem.
  1015.  
  1016.  
  1017.  
  1018.  
  1019.        APPENDIX C - BUGS
  1020.        -----------------
  1021.  
  1022.           Although ORG has been tested thoroughly, I cannot guarantee that
  1023.           it is truly free of bugs.  If you encounter what you believe to
  1024.           be a bug in ORG, you should try the following steps before calling
  1025.           or sending in a "Bug Report":
  1026.  
  1027.           Remove all TSR programs from your system, especially programs such
  1028.           as disk cache software or RAM drives or, better still, re-boot the
  1029.           computer from a "virgin" DOS diskette and try to run ORG again. If
  1030.           ORG runs in this environment but not in your normal DOS
  1031.           environment, try reconstructing the system under which ORG failed
  1032.           by adding drivers and TSR's one by one until the problem re-
  1033.           appears.  If you find the particular software which causes the
  1034.           trouble, please let me know about it, so that I can warn other
  1035.           users and try to find a "workaround" and send you an upgrade.
  1036.  
  1037.           If the above approach does not work, please send me a detailed
  1038.           report including a full description of your system and I will
  1039.           try to help you find the problem.
  1040.  
  1041.                                        Page 19
  1042.           
  1043.        Documentation for ORG V1.33            Copyright 1990, M.H. Greve
  1044.  
  1045.  
  1046.  
  1047.  
  1048.        ORG - REGISTRATION
  1049.        ------------------
  1050.  
  1051.           Please complete the attached form and return it with US$25.00
  1052.           (or US$45.00 if you want full Microsoft C source code and object
  1053.       libraries).  Send cash by registered air-mail. Send checks by
  1054.           regular air-mail. (add US$3.- for check handling charges outside
  1055.           North America).
  1056.  
  1057.  
  1058.       If you live in the US or Canada, please send your registration
  1059.       to:
  1060.  
  1061.                          David Rifkind
  1062.                          1800 W. Hillcrest Drive #287
  1063.                          Newbury Park, CA 91320
  1064.                          (USA)
  1065.  
  1066.  
  1067.       If you are registering from outside North America, please send
  1068.       your registration to:
  1069.  
  1070.                          Michael H. Greve
  1071.                          Aubrigstrasse 23
  1072.                          CH 8804 AU
  1073.                          Switzerland
  1074.  
  1075.  
  1076.  
  1077.  
  1078.                            ORG - REGISTRATION FORM
  1079.                            -----------------------
  1080.  
  1081.           Last Name:__________________________  Other Names:________________
  1082.  
  1083.           Address:____________________________  Town/City:__________________
  1084.  
  1085.           State or Country:___________________  Telephone:__________________
  1086.  
  1087.           Post Code:________
  1088.  
  1089.  
  1090.           I wish to receive the full Microsoft C source code:_______________
  1091.           (including object library of support functions)
  1092.  
  1093.           I enclose a check (___), cash (___) for $_________________________
  1094.  
  1095.           I understand that this software is supplied without warranty,
  1096.           express or implied, and agree not to hold its author liable for
  1097.           any direct or consequential loss arising out of my use of it.
  1098.  
  1099.           Signature:______________________________
  1100.  
  1101.           ------------------------------------------------------------------
  1102.           Please also answer the following questions. They may help in
  1103.           diagnosing your problems and provide the author with some
  1104.           statistical data on ORG users.
  1105.  
  1106.           On what type(s) of computer are you using ORG ? __________________
  1107.  
  1108.           CPU (8088, 8086, etc.)? __________   Amount of RAM (kB)? _________
  1109.  
  1110.           Type & Size of Hard Disk(s)? _____________________________________
  1111.  
  1112.           Make and Type of Hard Disk Controller(s)? ________________________
  1113.  
  1114.           How did you obtain/hear about this program?
  1115.  
  1116.           Did you think that the registration fee for this program was:
  1117.  
  1118.           Very Good Value_________  About Right________  Too High___________
  1119.  
  1120.           What did you think of the documentation provided with ORG ?
  1121.  
  1122.           Very Good_______________  Adequate___________  Inadequate_________
  1123.  
  1124.           Comments & suggestions:___________________________________________
  1125.  
  1126.           __________________________________________________________________
  1127.  
  1128.       __________________________________________________________________
  1129.  
  1130.       __________________________________________________________________
  1131.  
  1132.  
  1133.